mdbt42q.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef MDBT42Q_H
#define MDBT42Q_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"




#define MDBT42Q_CMD_SET_PARAM_DEVICE_NAME       "AT+NAME"
#define MDBT42Q_CMD_SET_BAUDRATE_9600           "AT+BAUDRATE9600"
#define MDBT42Q_CMD_SET_BAUDRATE_19200          "AT+BAUDRATE19200"
#define MDBT42Q_CMD_SET_BAUDRATE_38400          "AT+BAUDRATE38400"
#define MDBT42Q_CMD_SET_BAUDRATE_57600          "AT+BAUDRATE57600"
#define MDBT42Q_CMD_SET_BAUDRATE_115200         "AT+BAUDRATE115200"
#define MDBT42Q_CMD_SET_BAUDRATE_230400         "AT+BAUDRATE230400"
#define MDBT42Q_CMD_SET_BAUDRATE_460800         "AT+BAUDRATE460800"
#define MDBT42Q_CMD_ENABLE_FLOW_CONTROL         "AT+FLOWCONTROLEN"
#define MDBT42Q_CMD_DISABLE_FLOW_CONTROL        "AT+FLOWCONTROLDIS"
#define MDBT42Q_CMD_SET_TX_POWER_4DBM           "AT+TXPOWER4DBM"
#define MDBT42Q_CMD_SET_TX_POWER_0DBM           "AT+TXPOWER0DBM"
#define MDBT42Q_CMD_SET_TX_POWER_MINUS_4DBM     "AT+TXPOWER-4DBM"
#define MDBT42Q_CMD_SET_TX_POWER_MINUS_8DBM     "AT+TXPOWER-8DBM"
#define MDBT42Q_CMD_SET_TX_POWER_MINUS_20DBM    "AT+TXPOWER-20DBM"
#define MDBT42Q_CMD_USE_INTERNAL_XTAL           "AT+XTALINTERNAL"
#define MDBT42Q_CMD_USE_EXTERNAL_XTAL           "AT+XTALEXTERNAL"
#define MDBT42Q_CMD_SET_CONNECT_IND_LOW         "AT+CONNECTINDICATORLOW"
#define MDBT42Q_CMD_SET_CONNECT_IND_HIGH        "AT+CONNECTINDICATORHIGH"
#define MDBT42Q_CMD_SET_PHYMODE_1MBPS           "AT+PHYMODE1MBPS"
#define MDBT42Q_CMD_SET_PHYMODE_2MBPS           "AT+PHYMODE2MBPS"
#define MDBT42Q_CMD_SET_WAKEUP_LOW              "AT+WAKEUPLOW"
#define MDBT42Q_CMD_SET_WAKEUP_HIGH             "AT+WAKEUPHIGH"
#define MDBT42Q_CMD_SET_PARAM_ADV_TIME          "AT+ADVTIME"
#define MDBT42Q_CMD_DISABLE_DCDC                "AT+DCDCDIS"
#define MDBT42Q_CMD_ENABLE_DCDC                 "AT+DCDCEN"
#define MDBT42Q_CMD_SET_CONN_INTERVAL_MODE_0    "AT+CONNECTINTERVALMODE0"
#define MDBT42Q_CMD_SET_CONN_INTERVAL_MODE_1    "AT+CONNECTINTERVALMODE1"
#define MDBT42Q_CMD_SET_CONN_INTERVAL_MODE_2    "AT+CONNECTINTERVALMODE2"
#define MDBT42Q_CMD_SET_PARAM_CONN_INTERVAL_T   "AT+CONNECTINTERVALTIME"
#define MDBT42Q_CMD_SET_PARAM_ADV_LED_PATTERN   "AT+ADVPATTERN"
#define MDBT42Q_CMD_SET_PARAM_CONN_LED_PATTERN  "AT+CONNECTPATTERN"
#define MDBT42Q_CMD_SET_PARAM_SERIAL_NUMBER     "AT+SERIALNO"
#define MDBT42Q_CMD_DISABLE_RESPONSE            "AT+RESPONSEDIS"
#define MDBT42Q_CMD_ENABLE_RESPONSE             "AT+RESPONSEEN"
#define MDBT42Q_CMD_SET_PARAM_MAC_ADDRESS       "AT+MACADDR"
#define MDBT42Q_CMD_RESET                       "AT+RESET"
#define MDBT42Q_CMD_ADV_START                   "AT+ADVSTART"
#define MDBT42Q_CMD_ADV_STOP                    "AT+ADVSTOP"
#define MDBT42Q_CMD_ENTER_SLEEP                 "AT+SLEEP"
#define MDBT42Q_CMD_DISCONNECT                  "AT+DISCONNECT"
#define MDBT42Q_CMD_RESTORE_DEFAULT             "AT+DEFAULT"
#define MDBT42Q_CMD_SET_GPIO_12_HIGH            "AT+SETGPIO12HIGH"
#define MDBT42Q_CMD_SET_GPIO_13_HIGH            "AT+SETGPIO13HIGH"
#define MDBT42Q_CMD_SET_GPIO_14_HIGH            "AT+SETGPIO14HIGH"
#define MDBT42Q_CMD_SET_GPIO_15_HIGH            "AT+SETGPIO15HIGH"
#define MDBT42Q_CMD_SET_GPIO_16_HIGH            "AT+SETGPIO16HIGH"
#define MDBT42Q_CMD_SET_GPIO_17_HIGH            "AT+SETGPIO17HIGH"
#define MDBT42Q_CMD_SET_GPIO_18_HIGH            "AT+SETGPIO18HIGH"
#define MDBT42Q_CMD_SET_GPIO_19_HIGH            "AT+SETGPIO19HIGH"
#define MDBT42Q_CMD_SET_GPIO_12_LOW             "AT+SETGPIO12LOW"
#define MDBT42Q_CMD_SET_GPIO_13_LOW             "AT+SETGPIO13LOW"
#define MDBT42Q_CMD_SET_GPIO_14_LOW             "AT+SETGPIO14LOW"
#define MDBT42Q_CMD_SET_GPIO_15_LOW             "AT+SETGPIO15LOW"
#define MDBT42Q_CMD_SET_GPIO_16_LOW             "AT+SETGPIO16LOW"
#define MDBT42Q_CMD_SET_GPIO_17_LOW             "AT+SETGPIO17LOW"
#define MDBT42Q_CMD_SET_GPIO_18_LOW             "AT+SETGPIO18LOW"
#define MDBT42Q_CMD_SET_GPIO_19_LOW             "AT+SETGPIO19LOW"
#define MDBT42Q_CMD_SET_GPIO_12_OFF             "AT+SETGPIO12OFF"
#define MDBT42Q_CMD_SET_GPIO_13_OFF             "AT+SETGPIO13OFF"
#define MDBT42Q_CMD_SET_GPIO_14_OFF             "AT+SETGPIO14OFF"
#define MDBT42Q_CMD_SET_GPIO_15_OFF             "AT+SETGPIO15OFF"
#define MDBT42Q_CMD_SET_GPIO_16_OFF             "AT+SETGPIO16OFF"
#define MDBT42Q_CMD_SET_GPIO_17_OFF             "AT+SETGPIO17OFF"
#define MDBT42Q_CMD_SET_GPIO_18_OFF             "AT+SETGPIO18OFF"
#define MDBT42Q_CMD_SET_GPIO_19_OFF             "AT+SETGPIO19OFF"
#define MDBT42Q_CMD_GET_DEVICE_NAME             "AT?NAME"
#define MDBT42Q_CMD_GET_VERSION                 "AT?VERSION"
#define MDBT42Q_CMD_GET_MAC_ADDRESS             "AT?MACADDR"
#define MDBT42Q_CMD_GET_BAUD_RATE               "AT?BAUDRATE"
#define MDBT42Q_CMD_GET_FLOW_CONTROL            "AT?FLOWCONTROL"
#define MDBT42Q_CMD_GET_TX_POWER                "AT?TXPOWER"
#define MDBT42Q_CMD_GET_OSCILLATOR              "AT?XTAL"
#define MDBT42Q_CMD_GET_CONNECT_INDICATOR       "AT?CONNECTINDICATOR"
#define MDBT42Q_CMD_GET_PHY_MODE                "AT?PHYMODE"
#define MDBT42Q_CMD_GET_WAKEUP_MODE             "AT?WAKEUP"
#define MDBT42Q_CMD_GET_ADV_TIME                "AT?ADVTIME"
#define MDBT42Q_CMD_GET_DCDC_STATUS             "AT?DCDC"
#define MDBT42Q_CMD_GET_CONN_INTERVAL_MODE      "AT?CONNECTINTERVALMODE"
#define MDBT42Q_CMD_GET_ADV_LED_PATTERN         "AT?ADVPATTERN"
#define MDBT42Q_CMD_GET_CONN_LED_PATTERN        "AT?CONNECTPATTERN"
#define MDBT42Q_CMD_GET_SERIAL_NUMBER           "AT?SERIALNO"
#define MDBT42Q_CMD_GET_ADC_VALUE               "AT?ADCVALUE"
#define MDBT42Q_CMD_GET_RESPONSE_MODE           "AT?RESPONSE"
#define MDBT42Q_CMD_GET_ALL_PARAMETERS          "AT?ALLPARAMETERS"
#define MDBT42Q_CMD_GET_CONN_INTERVAL_TIME      "AT?CONNECTINTERVALTIME"

#define MDBT42Q_TX_DRV_BUFFER_SIZE              200
#define MDBT42Q_RX_DRV_BUFFER_SIZE              600
 // mdbt42q_cmd



#define MDBT42Q_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.ind = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.pd = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
 // mdbt42q_map // mdbt42q

typedef struct
{
    // Output pins
    digital_out_t rst;              
    digital_out_t cts;              
    digital_out_t pd;               
 
    // Input pins
    digital_in_t ind;               
    digital_in_t rts;               
 
    // Modules
    uart_t uart;                    
 
    // Buffers
    uint8_t uart_rx_buffer[ MDBT42Q_RX_DRV_BUFFER_SIZE ];   
    uint8_t uart_tx_buffer[ MDBT42Q_TX_DRV_BUFFER_SIZE ];   
    uint8_t cmd_buffer[ MDBT42Q_TX_DRV_BUFFER_SIZE ];       
 
} mdbt42q_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
 
    // Additional gpio pins
    pin_name_t ind;                 
    pin_name_t rst;                 
    pin_name_t cts;                 
    pin_name_t pd;                  
    pin_name_t rts;                 
 
    // Static variable
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
 
} mdbt42q_cfg_t;

typedef enum
{
    MDBT42Q_OK = 0,
    MDBT42Q_ERROR = -1,
    MDBT42Q_ERROR_TIMEOUT = -2
 
} mdbt42q_return_value_t;


void mdbt42q_cfg_setup ( mdbt42q_cfg_t *cfg );

err_t mdbt42q_init ( mdbt42q_t *ctx, mdbt42q_cfg_t *cfg );

err_t mdbt42q_generic_write ( mdbt42q_t *ctx, uint8_t *data_in, uint16_t len );

err_t mdbt42q_generic_read ( mdbt42q_t *ctx, uint8_t *data_out, uint16_t len );

void mdbt42q_set_rst_pin ( mdbt42q_t *ctx, uint8_t state );

void mdbt42q_set_pd_pin ( mdbt42q_t *ctx, uint8_t state );

void mdbt42q_set_cts_pin ( mdbt42q_t *ctx, uint8_t state );

uint8_t mdbt42q_get_rts_pin ( mdbt42q_t *ctx );

uint8_t mdbt42q_get_ind_pin ( mdbt42q_t *ctx );

void mdbt42q_reset_device ( mdbt42q_t *ctx );

void mdbt42q_cmd_run ( mdbt42q_t *ctx, uint8_t *cmd );

void mdbt42q_cmd_set ( mdbt42q_t *ctx, uint8_t *cmd, uint8_t *value );
 
#ifdef __cplusplus
}
#endif
#endif // MDBT42Q_H
 // mdbt42q
 
// ------------------------------------------------------------------------ END